<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>RaxanBase | Raxan User Guide</title>
    <link href="../raxan/styles/master.css" rel="stylesheet" type="text/css" />
    <!--[if IE]><link rel="stylesheet" href="../raxan/styles/master.ie.css" type="text/css"><![endif]-->
    <link href="style.css" rel="stylesheet" type="text/css" />
    <link href="highlight/styles/default.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" src="highlight/highlight.js"></script>
    <script type="text/javascript">
        hljs.initHighlightingOnLoad('javascript','html','php');
    </script>

</head>

<body>
    <div class="container c48 prepend-top">
        <h2 class="bottom">Raxan User Guide</h2>
        <div class="navbar">
            <div class="lf"><div class="rt"><div class="md">
                <ul>
                    <li><a href="../index.html" title="The Rich Ajax, CSS &amp; PHP Framework" >Home</a></li>
                    <li><a href="table-of-contents.html" title="Blog Posts" >Table Of Contents</a></li>
                    <li><a href="../php-examples/index.php" title="PHP Examples" >PHP Examples</a></li>
                    <li><a href="../css-examples/index.html" title="User Guide" >CSS Examples</a></li>
                </ul>
            </div></div></div>
        </div>
        <div class="prepend1 append1">
            <div class="ltm" align="right">
                <a href="table-of-contents.html" title="Show Table of Content">
                    <img src="images/toc-button.png"  alt="Table of Contents" />
                </a>
            </div>
            <div class="container c45">

    <h2 class="class-name">Class RaxanBase</h2>

    <a name="sec-description"></a>
    <div class="box bmm">
        <div class="box-title">Description</div>
        <div class="nav-bar">
            <span class="disabled">Description</span> |
            <a href="#sec-descendents">Descendents</a>
            |                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
            |                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="box bmm-body">
            <!-- ========== Info from phpDoc block ========= -->
            <ul class="tags">
                <li><span class="field">abstract:</span> </li>
            </ul>
            <p class="notes">
                Located in <a class="field" href="#">raxan/pdi/shared/raxan.php</a> (line <span class="field">901</span>)
            </p>


            <pre></pre>

        </div>
    </div>

    <a name="sec-descendents"></a>
    <div class="box bmm">
        <div class="box-title">Direct descendents</div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <span class="disabled">Descendents</span>
            |                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
            |                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="box bmm-body">
            <table cellpadding="2" cellspacing="0" class="class-table">
                <tr>
                    <th class="class-table-header">Class</th>
                    <th class="class-table-header">Description</th>
                </tr>
                <tr>
                    <td style="padding-right: 2em"><a href="RichAPIBase.html">RichAPIBase</a></td>
                    <td>

                    </td>
                </tr>
                <tr>
                    <td style="padding-right: 2em"><a href="RaxanElement.html">RaxanElement</a></td>
                    <td>
                        The Raxan Element Class is used to traverse and manipulate a set of matched DOM elements
                    </td>
                </tr>
                <tr>
                    <td style="padding-right: 2em"><a href="RaxanWebPage.html">RaxanWebPage</a></td>
                    <td>
                        Use for traversing and manipulating HTML DOM elements
                    </td>
                </tr>
            </table>
        </div>
    </div>


    <a name="sec-var-summary"></a>
    <div class="box bmm">
        <div class="box-title">Variable Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-descendents">Descendents</a> |
            <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
            |
            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="box bmm-body">
            <div class="var-summary">
                <div class="var-title">
                    static <span class="var-type">mixed</span>
                    <a href="#$mObjId" title="details" class="var-name">$mObjId</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$events" title="details" class="var-name">$events</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$objId" title="details" class="var-name">$objId</a>
                </div>
            </div>
        </div>
    </div>

    <a name="sec-method-summary"></a>
    <div class="box bmm">
        <div class="box-title">Method Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-descendents">Descendents</a> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

            |
            <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
        </div>
        <div class="box bmm-body">
            <div class="method-summary">

                <div class="method-definition">
                    <span class="method-result">RaxanBase</span>
                    <a href="#__construct" title="details" class="method-name">__construct</a>
                    ()
                </div>
                <div class="method-definition">
                    <span class="method-result"><a href="RaxanBase.html">RaxanBase</a></span>
                    <a href="#bind" title="details" class="method-name">bind</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fn</span> = <span class="var-default">null</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">Boolean</span>
                    <a href="#log" title="details" class="method-name">log</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$var</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$label</span> = <span class="var-default">null</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">int</span>
                    <a href="#objectId" title="details" class="method-name">objectId</a>
                    ()
                </div>
                <div class="method-definition">
                    <span class="method-result"><a href="RaxanBase.html">RaxanBase</a></span>
                    <a href="#trigger" title="details" class="method-name">trigger</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$args</span> = <span class="var-default">null</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result"><a href="RaxanBase.html">RaxanBase</a></span>
                    <a href="#unbind" title="details" class="method-name">unbind</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
                </div>
            </div>
        </div>
    </div>

    <a name="sec-vars"></a>
    <div class="box bmm">
        <div class="box-title">Variables</div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-descendents">Descendents</a> |
            <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)


            |
            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="box bmm-body">
            <a name="var$mObjId" id="$mObjId"><!-- --></a>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        static <span class="var-type">mixed</span>
                        <span class="var-name">$mObjId</span>
                        = <span class="var-default"> 0</span>            (line <span class="line-number">903</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> protected</li>
                </ul>





            </div>
            <a name="var$events" id="$events"><!-- --></a>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$events</span>
                        (line <span class="line-number">904</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> protected</li>
                </ul>





            </div>
            <a name="var$objId" id="$objId"><!-- --></a>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$objId</span>
                        (line <span class="line-number">904</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> protected</li>
                </ul>





            </div>

        </div>
    </div>

    <a name="sec-methods"></a>
    <div class="box bmm">
        <div class="box-title">Methods</div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-descendents">Descendents</a> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
            <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)

        </div>
        <div class="box bmm-body">
            <a name='method_detail'></a>
            <a name="method__construct" id="__construct"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">Constructor __construct</span> (line <span class="line-number">906</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">RaxanBase</span>
                    <span class="method-name">
                        __construct
                    </span>
                    ()
                </div>



                <hr class="separator" />
                <div class="notes">Redefined in descendants as:</div>
                <ul class="redefinitions">
                    <li>
                        <a href="RaxanElement.html#method__construct">RaxanElement::__construct()</a>
                        : RaxanElement(css,context)
                    </li>
                    <li>
                        <a href="RaxanUIElement.html#method__construct">RaxanUIElement::__construct()</a>
                    </li>
                    <li>
                        <a href="RaxanWebPage.html#method__construct">RaxanWebPage::__construct()</a>
                    </li>
                </ul>
            </div>
            <a name="methodbind" id="bind"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">bind</span> (line <span class="line-number">914</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Bind the selected event to a callback function</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result"><a href="RaxanBase.html">RaxanBase</a></span>
                    <span class="method-name">
                        bind
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$fn</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$type</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$data</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$fn</span>            </li>
                </ul>


                <hr class="separator" />
                <div class="notes">Redefined in descendants as:</div>
                <ul class="redefinitions">
                    <li>
                        <a href="RaxanElement.html#methodbind">RaxanElement::bind()</a>
                        : Binds matched element events to a callback function
                    </li>
                    <li>
                        <a href="RaxanWebPage.html#methodbind">RaxanWebPage::bind()</a>
                        : Binds an event to the page body element
                    </li>
                </ul>
            </div>
            <a name="methodlog" id="log"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">log</span> (line <span class="line-number">928</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Adds an entry to the log file</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Boolean</span>
                    <span class="method-name">
                        log
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$var</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$level</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$label</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$var</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$level</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$label</span>            </li>
                </ul>


            </div>
            <a name="methodobjectId" id="objectId"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">objectId</span> (line <span class="line-number">936</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns Object ID</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">int</span>
                    <span class="method-name">
                        objectId
                    </span>
                    ()
                </div>



            </div>
            <a name="methodtrigger" id="trigger"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">trigger</span> (line <span class="line-number">944</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Triggers an event on the object</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result"><a href="RaxanBase.html">RaxanBase</a></span>
                    <span class="method-name">
                        trigger
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$args</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$type</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$args</span>            </li>
                </ul>


                <hr class="separator" />
                <div class="notes">Redefined in descendants as:</div>
                <ul class="redefinitions">
                    <li>
                        <a href="RaxanElement.html#methodtrigger">RaxanElement::trigger()</a>
                        : Trigger events on the match elements
                    </li>
                </ul>
            </div>
            <a name="methodunbind" id="unbind"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">unbind</span> (line <span class="line-number">967</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Removes all event handlers for the specified event type</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result"><a href="RaxanBase.html">RaxanBase</a></span>
                    <span class="method-name">
                        unbind
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$type</span>            </li>
                </ul>


                <hr class="separator" />
                <div class="notes">Redefined in descendants as:</div>
                <ul class="redefinitions">
                    <li>
                        <a href="RaxanElement.html#methodunbind">RaxanElement::unbind()</a>
                        : Removes all event handlers for the specified event type
                    </li>
                </ul>
            </div>

        </div>
    </div>

</div>

        </div>
        <div class="tpb pad" style="text-align:right">
            <div class="right ltm">
                <a href="table-of-contents.html" title="Back to Table of Content">
                    <img src="images/toc-button.png"  alt="Table of Contents" />
                </a>
            </div>
        </div>
    </div>
</body>

</html>

